home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / comm / mcm10.zip / SRIF102.ZIP / SRIF.TXT < prev   
Text File  |  1996-06-02  |  9KB  |  204 lines
  1.  
  2.                 Information / Description of a new standard
  3.  
  4.                                 S  tandard
  5.                                 R  equest
  6.                                 I  nformation
  7.                                 F  ile
  8.  
  9.          Copyright (c) 1994,95,96 by Gordian Schuermann & Mirko Mucko
  10.  
  11.                 Current revision  1.02, dated of June 02 1996
  12.  
  13.                  The latest revision of this document is avail
  14.                       for file request with magic "SRIF"
  15.  
  16.  
  17. I  Overview
  18.                 Introduction                            0
  19.                 Contact person                          0.1
  20.                 Description in general                  1
  21.                   Required statements                   1.1
  22.                   Optional statements                   1.2
  23.                   Undefined options                     1.3
  24.                 Implementation                          2.0
  25.                 Updates to this revision                3.0
  26.  
  27.  
  28. 0. Introduction
  29.  In common, more and more mailer are about to implement the ability to
  30.  call external request processors. But very soon, we discovered a command
  31.  line cannot handle all the information the mailer has and the ERP needs.
  32.  
  33.  To transfer the information in a proper and fast way, we designed and
  34.  implemented the S R I F option in the mean it will be a standard soon.
  35.  
  36.  The structure and idea is protected by copyright law, except these
  37.  circumstances:
  38.  
  39.         +  you may distrubute, use and implement this structure for free
  40.         +  you have not to pay any value for usage of these methodes
  41.         +  you should note in your documentation the origin of SRIF
  42.  
  43. 0.1 Contact persons
  44.  In case of trouble understanding SRIF, the concept, meaning ot purpose
  45.  of ot, or even have questions concerning the implementation, or if you
  46.  have bug fixes or any other note for us, you may reach us at:
  47.  
  48.         Mirko Mucko
  49.  
  50.         e-mail  fidonet   2:2433/920.0
  51.                 internet  mirko.mucko@technet.net
  52.  
  53.         FAX     +49-211-9083026
  54.  
  55.         snail   Mirko Mucko
  56.                 Thomas-Mann-Str. 43
  57.                 40470 Duesseldorf
  58.                 GERMANY
  59.  
  60. 1. Descritption
  61.  The SRIF name is the only parameter given from the Mailer to the External
  62.  Request Processor. The file is designated as a so called "plain vanilla ASCII"
  63.  file, filled with pre-defined, optional and not-yet defined statemets.
  64.  
  65.  We discussed the possibility of binary files, and of EMSI-like files, but
  66.  a plain ASCII control file is more flexible and can be read faster by
  67.  various program languages (C, Pascal, Basic, Cobol ect).
  68.  
  69.  In the SRIF, one command plus parameter is allowed per line, the file
  70.  is unlimited in length, comments are not allowed.
  71.  
  72.  The SRIF is generated by the Mailer and after the ERP finished its work,
  73.  the Mailer is responsible for erasing the SRIF.
  74.  
  75. 1.1 Required statements
  76.  The following statements are required for the ERP:
  77.  
  78.  
  79.        Sysop            <Sysop_Name>
  80.                         This is the name of the remote sysop
  81.  
  82.        AKA              <Zone:Net/Node[.Point][@Domain]>
  83.                         This is the main aka of the remote system in 4D or
  84.                         5D notation. A zero as point number may be ommited,
  85.                         the domain with "@" is optional
  86.  
  87.        Baud             <Current LINE rate>
  88.                         This is the effective baud rate, not the fixed DTE rate
  89.  
  90.        Time             <Time in minutes>
  91.                         This is the time till next event which does not allow
  92.                         file requests. Use -1 if no limits
  93.  
  94.        RequestList      <File of request list>
  95.                         This is the filename of the list containing requested
  96.                         files.
  97.        ResponseList     <File of response list>
  98.                         This is the filename of the response list.
  99.                         It must not be equal to RequestList. One file per line,
  100.                         including drives/pathes to the file. The first
  101.                         character defines the way the mailer should act after
  102.                         sending that file:
  103.  
  104.                          =   erase file if sent successfully
  105.                          +   do not erase the file after sent
  106.                          -   erase the file in any case after session
  107.  
  108.        RemoteStatus     <PROTECTED or UNPROTECTED>
  109.                         Defines whether the session is protected by password
  110.                         or not
  111.  
  112.        SystemStatus     <LISTED or UNLISTED>
  113.                         Defines whether the remote system is listed in any
  114.                         current nodelist of system.
  115.  
  116. 1.2 Optional statements
  117.  These parameters are already known and defined, but a ERP should run also
  118.  without them:
  119.  
  120.        SessionProtocoll <e.g. ZAP,ZMO,XMA
  121.  
  122.        AKA              <Zone:Net/Node[.Point][@Domain]>
  123.                         Additional AKAs. One AKA is required (see REQUIRED
  124.                         section)
  125.  
  126.        Site             <Site Info>
  127.                          The site info as given e.g. in EMSI handshake
  128.  
  129.        Location         <Location and/or ZIP>
  130.                          The location info as given e.g. in EMSI handshake
  131.  
  132.        Phone            <Phone Number>
  133.                          The  phone number info as given e.g. in EMSI handshake
  134.  
  135.        CallerID         <Phone Number>
  136.                          The phone number as delivered by the PTT. This is
  137.                          only possible in digital networks like ISDN.
  138.  
  139.  
  140.        Password         <Session password>
  141.                          On protected sessions, the session password. If
  142.                          no protected session, this parameter must be ommited!
  143.  
  144.        DTE              <Current DTE rate>
  145.                          The PC<->Modem speed (so call DTE rate)
  146.  
  147.        PORT             <COM Port from 1 to 8>
  148.                          The FOSSIL Communication Port. The Mailer should
  149.                          leave the fossil "hot" for the Request Processor
  150.  
  151.        Mailer           <Remote's mailer if EMSI>
  152.                           The Mailer name as defined by FTC
  153.  
  154.        MailerCode       <Remote's FTSC code>
  155.                           The hex code of the remote mailer as defined by FTC
  156.  
  157.        SerialNumber     <Remote's serial number if passed>
  158.                          The remote mailer's serial number if transfered
  159.  
  160.        Version          <Remote's version number if EMSI>
  161.                          The remote mailer's version number if transfered
  162.  
  163.        Revision         <remote's revision number if EMSI>
  164.                          The remote mailer's revision number if transfered
  165.  
  166.        SessionType      <may be EMSI, FTSC0001, WAZOO, JANUS, HYDRA or OTHER>
  167.                          The session-type, this may be one of the known
  168.                          session types or "OTHER" if not (yet) defined
  169.  
  170.        OurAKA           <AKA which has been called for proper response>
  171.                          If the mailer does AKA matching, the AKA of the
  172.                          mailer being called
  173.  
  174.        TRANX            <Tranx Line as 8 digit hex string>
  175.                          The unix-style time stamp (hexadecimal notation
  176.                          of seconds since 1.1.1980)
  177.  
  178. 1.3 Undefined options
  179.  There may be the need to add new commands / parameters to the SRIF file. If
  180.  so, they may be added, but inform us to keep the documentation "up to date"
  181.  and to share your good ideas with other autors of software for FIDONet.
  182.  
  183.  
  184. 2.0 Implementation
  185.  SRIF is implemented in these fine products already :
  186.  
  187.                 Mailer                  Request Processor
  188.                 ------------------------------------------------------
  189.                 McMail                  xOR
  190.                 Xenia                   EasyERP
  191.                 TMail [*]
  192.  
  193.   [*] means : SRIF is not completely correct implemented and therefor
  194.               may cause troubles in operation
  195.  
  196.  Other products will follow soon ! If YOUR product also supports SRIF,
  197.  just drop us a mail and we will include it here.
  198.  
  199. 3.0 Updates to this revision
  200.  To revision 1.02, we added the "CallerID" field within optional parameters
  201.  to make Request Reject possible depending on the delivered phone number.
  202.  This is only possible in ISDN and similar networks and must be supported
  203.  by the mailer AND the fossil.
  204.  Also, section 0.1 (contact person) has been added.